<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<HTML>
<HEAD><meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<title>Marker Updaters</title>
<style type="text/css">@import url("file:/home/moovida/rcpdevelopment/eclipse/configuration/org.eclipse.osgi/bundles/488/1/.cp/book.css");</style>
<style type="text/css">@import url("file:/home/moovida/rcpdevelopment/eclipse/configuration/org.eclipse.osgi/bundles/505/1/.cp/schema.css");</style>
</HEAD>
<BODY>
<H1 style="text-align:center">Marker Updaters</H1>
<p></p>
<h6 class="CaptionFigColumn SchemaHeader">Identifier: </h6>org.eclipse.ui.editors.markerUpdaters<p></p>
<h6 class="CaptionFigColumn SchemaHeader">Since: </h6>3.0 (originally named org.eclipse.ui.markerUpdaters)
<p></p>

<h6 class="CaptionFigColumn SchemaHeader">Description: </h6>This extension point is used for registering marker update strategies with marker annotation models. A resource that is opened in a text editor is associated with a marker annotation model. For each marker attached to the resource this model manages a position that is updated with each change applied to the text in the editor. If the resource is saved, the text in the editor and the position managed for a marker are passed over to the registered marker update strategies. These strategies can then update the marker's attributes based on the text and the position. Marker update strategies are requested to implement the interface <code>org.eclipse.ui.texteditor.IMarkerUpdater</code>. The update strategies can be registered either for a particular marker type or all marker types. The latter by omitting any marker type in the extension.<p></p>
<h6 class="CaptionFigColumn SchemaHeader">Configuration Markup:</h6>
<p></p>
<p class="code SchemaDtd">&lt;!ELEMENT <a name="e.extension">extension</a> (<a href="#e.updater">updater</a>+)&gt;</p>
<p class="code SchemaDtd">&lt;!ATTLIST extension</p>
<p class="code SchemaDtdAttlist">point&nbsp;CDATA #REQUIRED</p><p class="code SchemaDtdAttlist">id&nbsp;&nbsp;&nbsp;&nbsp;CDATA #IMPLIED</p><p class="code SchemaDtdAttlist">name&nbsp;&nbsp;CDATA #IMPLIED</p>&gt;</p>
<p></p>
<ul class="ConfigMarkupAttlistDesc">
<li><b>point</b> - a fully qualified identifier of the target extension point</li>
<li><b>id</b> - an optional identifier of the extension instance</li>
<li><b>name</b> - an optional name of the extension instance</li>
</ul>
<br><p class="code SchemaDtd">&lt;!ELEMENT <a name="e.updater">updater</a> EMPTY&gt;</p>
<p class="code SchemaDtd">&lt;!ATTLIST updater</p>
<p class="code SchemaDtdAttlist">id&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CDATA #REQUIRED</p><p class="code SchemaDtdAttlist">markerType&nbsp;IDREF #IMPLIED</p><p class="code SchemaDtdAttlist">class&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CDATA #REQUIRED</p>&gt;</p>
<p></p>
<ul class="ConfigMarkupAttlistDesc">
<li><b>id</b> - the unique id of this updater</li>
<li><b>markerType</b> - the name of the marker type</li>
<li><b>class</b> - the qualified name of the marker updater class</li>
</ul>
<br><h6 class="CaptionFigColumn SchemaHeader">Examples: </h6><pre class="Example"><span class="code SchemaTag">
&lt;extension point= </span><span class="code SchemaCstring">&quot;org.eclipse.ui.editors.markerUpdaters&quot;</span><span class="code SchemaTag">&gt; 
    &lt;updater 
        id=</span><span class="code SchemaCstring">&quot;org.eclipse.jdt.ui.markerUpdaters.JavaSearchMarkerUpdater&quot;</span><span class="code SchemaTag"> 
        class=</span><span class="code SchemaCstring">&quot;org.eclipse.jdt.internal.ui.search.JavaSearchMarkerUpdater&quot;</span><span class="code SchemaTag"> 
        markerType=</span><span class="code SchemaCstring">&quot;org.eclipse.search.searchmarker&quot;</span><span class="code SchemaTag">&gt; 
    &lt;/updater&gt; 
&lt;/extension&gt; 
</span></pre>
<p>
This example registers <samp>org.eclipse.jdt.internal.ui.search.JavaSearchMarkerUpdater</samp> as a marker updater for all markers of the 
type <samp>org.eclipse.search.searchmarker</samp> including all its derived types.
</p>
<pre class="Example"><span class="code SchemaTag">
&lt;extension point= </span><span class="code SchemaCstring">&quot;org.eclipse.ui.editors.markerUpdaters&quot;</span><span class="code SchemaTag">&gt; 
    &lt;updater 
        id=</span><span class="code SchemaCstring">&quot;org.eclipse.ui.texteditor.BasicMarkerUpdater&quot;</span><span class="code SchemaTag"> 
        class=</span><span class="code SchemaCstring">&quot;org.eclipse.ui.texteditor.BasicMarkerUpdater&quot;</span><span class="code SchemaTag">&gt; 
    &lt;/updater&gt; 
&lt;/extension&gt; 
</span></pre>
<p>
This example registers <samp>org.eclipse.ui.texteditor.BasicMarkerUpdater</samp> as a marker updater independent from the type of the marker. 
</p>
<p></p>

<h6 class="CaptionFigColumn SchemaHeader">API Information: </h6>Registered marker updaters have to implement the interface <samp>org.eclipse.ui.texteditor.IMarkerUpdater</samp>.
<p></p>

<br>
<p class="note SchemaCopyright">
Copyright (c) 2001, 2008 IBM Corporation and others.<br>
All rights reserved. This program and the accompanying materials are made available under the terms of the Eclipse Public License v1.0 which accompanies this distribution, and is available at <a href="http://www.eclipse.org/legal/epl-v10.html">http://www.eclipse.org/legal/epl-v10.html</a>

</p>
</BODY>
</HTML>
